Edit Task: SetPossibility CapacityType
Description
The SetPossibility CapacityType attribute under EditTask defines the resource usage's capacity type for a single task possibility.
Parameters
| Parameter | Description |
|---|---|
| PossibilityName | A string of text with a comma delimited list of resources in the possibility. Order is not required and the resource names should not be in quotes. |
| ResourceName | The parameter is a string of text of the resource that is being defined by the command. |
| CapacityType | Options are "NotApplicable", "Deplete", "Replenish", "Resilient", "SetEndValue", "ReplenishAtStart", "DepleteAtStop", "StateMode", "WithinRange", "StateModeMatrix", "SetStartValue". This value must be compatible with the corresponding resource capacity attributes. |
Examples
Change the resource usage type to Deplete for ResB in the possibility that uses ResA, ResB and ResC
PATCH api/task/FUSEscience
Body:
{
"SetResourceDetails" : {
"PossibilityName" : "ResA,ResB,ResC",
"ResourceName" : "ResB",
"CapacityType" : "Deplete" }
}
